feat: Add `unnecessary_hook_widget` lint rule and quick fix #271

akaboshinit · 2025-03-02T20:02:29Z

Overview

add rule unnecessary_hook_widget
package split nilts_flutter_hooks

Fixes #

Feature type

Lint Rule
Quick fix
Assist
Other (Update docs, Configure CI, etc...)

Checklist

I have read the CONTRIBUTING docs.
I have written an related issue or linked with existing issues.
I have written tests and passed all of them.
- Use melos test to run tests.
I have updated docs (if needed).

gemini-code-assist

Hello @akaboshinit, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

Summary of Changes

This pull request introduces a new lint rule, unnecessary_hook_widget, to the nilts_flutter_hooks package. This rule identifies instances where HookWidget is used without utilizing any hooks, suggesting a replacement with StatelessWidget for better performance and code clarity. A quick fix is also provided to automatically replace HookWidget with StatelessWidget when appropriate. The PR also includes updates to the README to document the new lint rule, and adds a test case for the new lint rule.

Highlights

New Lint Rule: unnecessary_hook_widget: Adds a lint rule that flags HookWidget usages where no hooks are present, suggesting StatelessWidget as an alternative.
Quick Fix Implementation: Provides a quick fix to automatically replace unnecessary HookWidget usages with StatelessWidget.
Documentation Update: Updates the README file to include details and examples for the new unnecessary_hook_widget lint rule.
Test Case: Adds a test case to verify the functionality of the new lint rule.

Changelog

Click here to see the changelog

packages/nilts/README.md
- Added documentation for the unnecessary_hook_widget lint rule, including a description, target SDK, rule type, maturity level, and examples of good and bad code.
packages/nilts_flutter_hooks/.gitignore
- Added .gitignore file.
packages/nilts_flutter_hooks/CHANGELOG.md
- Added CHANGELOG.md file.
packages/nilts_flutter_hooks/README.md
- Added README.md file.
packages/nilts_flutter_hooks/analysis_options.yaml
- Added analysis_options.yaml file.
packages/nilts_flutter_hooks/example/example.md
- Added example.md file.
packages/nilts_flutter_hooks/lib/nilts_flutter_hooks.dart
- Introduced the _NiltsFlutterHooksLint class to define and register the UnnecessaryHookWidget lint rule.
packages/nilts_flutter_hooks/lib/src/change_priority.dart
- Added ChangePriority class to define the priority of the quick fix for replacing HookWidget with StatelessWidget.
packages/nilts_flutter_hooks/lib/src/lints/unnecessary_hook_widget.dart
- Implemented the UnnecessaryHookWidget lint rule, including the logic to detect unnecessary HookWidget usages and provide a quick fix to replace them with StatelessWidget.
packages/nilts_flutter_hooks/pubspec.yaml
- Created pubspec.yaml file.
packages/nilts_test/pubspec.yaml
- Added flutter_hooks as a dependency.
- Added nilts_flutter_hooks as a dependency.
packages/nilts_test/test/hooks_lints/unnecessary_hook_widget.dart
- Created a test file for the unnecessary_hook_widget lint rule, including test cases for both failing and passing scenarios.
release-please-config.json
- Added configuration for nilts_flutter_hooks package.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature	Command	Description
Code Review	`/gemini review`	Performs a code review for the current pull request in its current state.
Pull Request Summary	`/gemini summary`	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in issue comments and review comments.
Help	`/gemini help`	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

A HookWidget stands so tall,
But no hooks it uses at all.
The linter cries, 'Oh no, you see,
A StatelessWidget it should be!'

Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

gemini-code-assist

Code Review

The pull request introduces a new lint rule, unnecessary_hook_widget, which identifies opportunities to replace HookWidget with StatelessWidget when no hooks are used. The rule includes a quick fix. Overall, the implementation seems well-structured and includes relevant documentation and tests. However, there are a few areas that could be improved for clarity and consistency.

Merge Readiness

The pull request is almost ready for merging. I recommend addressing the comments to improve code clarity and consistency. I am unable to directly approve this pull request, and recommend that others review and approve this code before merging.

ronnnnn · 2025-03-10T16:09:17Z

packages/nilts/README.md

@@ -725,6 +726,51 @@ See also:

 </details>

+#### unnecessary_hook_widget


Don't add this in README on nilts.
You should separate README file.

I can write details after your PR merged.
Write minimal documentations please.

ronnnnn · 2025-03-10T16:11:05Z

packages/nilts_flutter_hooks/.gitignore

Don't use alias.
Define for nilts_flutter_hooks package.

Same as other alias files.

ronnnnn · 2025-03-10T16:15:53Z

release-please-config.json

I'll configure this before release.
You need not to add this, thanks.

ronnnnn · 2025-03-10T16:16:59Z

packages/nilts_flutter_hooks/pubspec.yaml

@@ -0,0 +1,34 @@
+name: nilts_flutter_hooks
+version: 0.19.0


Suggested change

version: 0.19.0

version: 0.1.0

ronnnnn · 2025-03-10T16:28:55Z

packages/nilts_flutter_hooks/lib/src/lints/unnecessary_hook_widget.dart

+  ) {
+    context.registry.addClassDeclaration((node) {
+      final superclass = node.extendsClause?.superclass;
+      if (superclass == null || superclass.toString() != 'HookWidget') return;


Add package name check.
You can define getter in nilts_core.
https://github.com/dassssshers/nilts/blob/main/packages/nilts_core/lib/src/utils/library_element_ext.dart

ronnnnn · 2025-03-10T16:32:21Z

packages/nilts_flutter_hooks/lib/src/lints/unnecessary_hook_widget.dart

+
+  @override
+  void visitMethodInvocation(MethodInvocation node) {
+    if (node.methodName.name.startsWith('use')) {


Should we consider private hooks which start with _use?

ronnnnn · 2025-03-10T16:41:15Z

packages/nilts_flutter_hooks/lib/src/lints/unnecessary_hook_widget.dart

+  }
+
+  @override
+  void visitFunctionExpressionInvocation(FunctionExpressionInvocation node) {


MethodInvocation includes FunctionExpressionInvocation.
This implementation may be unnecessary.

ronnnnn · 2025-03-10T16:43:12Z

packages/nilts_flutter_hooks/pubspec.yaml

@@ -0,0 +1,34 @@
+name: nilts_flutter_hooks
+version: 0.19.0
+description: nilts is lint rules, quick fixes and assists for Dart and Flutter projects that helps you enforce best practices, and avoid errors.


Suggested change

description: nilts is lint rules, quick fixes and assists for Dart and Flutter projects that helps you enforce best practices, and avoid errors.

description: nilts_flutter_hooks is lint rules, quick fixes and assists for Dart and Flutter projects using flutter_hooks that helps you enforce best practices, and avoid errors.

feat: Add unnecessary_hook_widget lint rule and quick fix

d803815

gemini-code-assist bot reviewed Mar 2, 2025

View reviewed changes

github-actions bot assigned akaboshinit Mar 2, 2025

akaboshinit added the feat New feature or request label Mar 2, 2025

gemini-code-assist bot reviewed Mar 2, 2025

View reviewed changes

autofix-ci bot and others added 3 commits March 2, 2025 20:04

[autofix.ci] apply automated fixes

f5cb8ca

chore: add example app

3837994

Merge branch 'main' into add-unnecessary-hook-widget

c014b96

akaboshinit marked this pull request as ready for review March 9, 2025 16:55

akaboshinit requested a review from ronnnnn as a code owner March 9, 2025 16:55

akaboshinit changed the title ~~feat: Add unnecessary_hook_widget lint rule and quick fix~~ feat: Add unnecessary_hook_widget lint rule and quick fix Mar 10, 2025

ronnnnn reviewed Mar 10, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add `unnecessary_hook_widget` lint rule and quick fix #271

feat: Add `unnecessary_hook_widget` lint rule and quick fix #271

akaboshinit commented Mar 2, 2025 •

edited

Loading

gemini-code-assist bot left a comment

gemini-code-assist bot left a comment

ronnnnn Mar 10, 2025

ronnnnn Mar 10, 2025

ronnnnn Mar 10, 2025

ronnnnn Mar 10, 2025

ronnnnn Mar 10, 2025

ronnnnn Mar 10, 2025

ronnnnn Mar 10, 2025

ronnnnn Mar 10, 2025

ronnnnn Mar 10, 2025

		@@ -725,6 +726,51 @@ See also:

		</details>

		#### unnecessary_hook_widget

	description: nilts is lint rules, quick fixes and assists for Dart and Flutter projects that helps you enforce best practices, and avoid errors.
	description: nilts_flutter_hooks is lint rules, quick fixes and assists for Dart and Flutter projects using flutter_hooks that helps you enforce best practices, and avoid errors.

feat: Add unnecessary_hook_widget lint rule and quick fix #271

Are you sure you want to change the base?

feat: Add unnecessary_hook_widget lint rule and quick fix #271

Conversation

akaboshinit commented Mar 2, 2025 • edited Loading

Overview

Feature type

Checklist

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Summary of Changes

Highlights

Changelog

Footnotes

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Merge Readiness

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

feat: Add `unnecessary_hook_widget` lint rule and quick fix #271

feat: Add `unnecessary_hook_widget` lint rule and quick fix #271

akaboshinit commented Mar 2, 2025 •

edited

Loading